home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Arsenal / OS2 Arsenal v1.0 (Disc 2)(Arsenal Computer).ISO / os2_inet / progcsd.exe / XDR.H < prev   
Encoding:
Text File  |  1993-02-24  |  16.1 KB  |  394 lines
  1. /********************************************************copyrite.xmc***/
  2. /*                                                                     */
  3. /*   Licensed Materials - Property of IBM                              */
  4. /*                                                                     */
  5. /*   This module is "Restricted Materials of IBM":                     */
  6. /*      Program Number:   5798RXW                                      */
  7. /*      Program Name:     IBM TCP/IP Version 1.2 for OS/2              */
  8. /*   (C) Copyright IBM Corporation. 1990, 1991.                        */
  9. /*                                                                     */
  10. /*   See IBM Copyright Instructions.                                   */
  11. /*                                                                     */
  12. /********************************************************copyrite.xmc***/
  13. /*
  14.  *     This product contains:
  15.  *              "Restricted Materials of IBM"
  16.  *              (c) Copyright IBM Corp. 1987
  17.  *              All Rights Reserved
  18.  *              Licensed Materials-Property of IBM
  19.  *
  20.  *     See Copyright Instructions, G120-2083
  21.  *
  22.  * $Header:   T:/tcp12vcs/pgmgkit/src/tcphdr32/include/rpc/xdr.h_v   1.2   24 Feb 1993 18:03:00   MCGARVEY  $
  23.  *
  24.  * $Log:   T:/tcp12vcs/pgmgkit/src/tcphdr32/include/rpc/xdr.h_v  $
  25.  * 
  26.  *    Rev 1.2   24 Feb 1993 18:03:00   MCGARVEY
  27.  * fixes for 3/93 CSD
  28.  *
  29.  *    Rev 1.0   22 Dec 1988 13:56:26   Philip Shafer/2
  30.  * Initial revision.
  31.  *
  32.  * @(#)xdr.h    1.1 87/11/04 3.9 RPCSRC
  33.  *
  34.  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
  35.  * unrestricted use provided that this legend is included on all tape
  36.  * media and as a part of the software program in whole or part.  Users
  37.  * may copy or modify Sun RPC without charge, but are not authorized
  38.  * to license or distribute it to anyone else except as part of a product or
  39.  * program developed by the user.
  40.  *
  41.  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  42.  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  43.  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  44.  *
  45.  * Sun RPC is provided with no support and without any obligation on the
  46.  * part of Sun Microsystems, Inc. to assist in its use, correction,
  47.  * modification or enhancement.
  48.  *
  49.  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  50.  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  51.  * OR ANY PART THEREOF.
  52.  *
  53.  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  54.  * or profits or other special, indirect and consequential damages, even if
  55.  * Sun has been advised of the possibility of such damages.
  56.  *
  57.  * Sun Microsystems, Inc.
  58.  * 2550 Garcia Avenue
  59.  * Mountain View, California  94043
  60.  *
  61.  *      @(#)xdr.h 1.19 87/04/22 SMI
  62.  *
  63.  * xdr.h, External Data Representation Serialization Routines.
  64.  *
  65.  * Copyright (C) 1984, Sun Microsystems, Inc.
  66.  *
  67.  * XDR provides a conventional way for converting between C data
  68.  * types and an external bit-string representation.  Library supplied
  69.  * routines provide for the conversion on built-in C data types.  These
  70.  * routines and utility routines defined here are used to help implement
  71.  * a type encode/decode routine for each user-defined type.
  72.  *
  73.  * Each data type provides a single procedure which takes two arguments:
  74.  *
  75.  *      bool_t
  76.  *      xdrproc(xdrs, argresp)
  77.  *              XDR *xdrs;
  78.  *              <type> *argresp;
  79.  *
  80.  * xdrs is an instance of a XDR handle, to which or from which the data
  81.  * type is to be converted.  argresp is a pointer to the structure to be
  82.  * converted.  The XDR handle contains an operation field which indicates
  83.  * which of the operations (ENCODE, DECODE * or FREE) is to be performed.
  84.  *
  85.  * XDR_DECODE may allocate space if the pointer argresp is null.  This
  86.  * data can be freed with the XDR_FREE operation.
  87.  *
  88.  * We write only one procedure per data type to make it easy
  89.  * to keep the encode and decode procedures for a data type consistent.
  90.  * In many cases the same code performs all operations on a user defined type,
  91.  * because all the hard work is done in the component type routines.
  92.  * decode as a series of calls on the nested data types.
  93.  */
  94. #ifndef RPC_XDR_H
  95. #define RPC_XDR_H
  96. #ifndef __32BIT__
  97. #define _Packed
  98. #define _Seg16
  99. #define _Far16
  100. #define _Cdecl
  101. #endif
  102.  
  103.  
  104. /*
  105.  * Xdr operations.  XDR_ENCODE causes the type to be encoded into the
  106.  * stream.  XDR_DECODE causes the type to be extracted from the stream.
  107.  * XDR_FREE can be used to release the space allocated by an XDR_DECODE
  108.  * request.
  109.  */
  110. enum xdr_op {
  111.         XDR_ENCODE=0,
  112.         XDR_DECODE=1,
  113.         XDR_FREE=2
  114. #ifdef __32BIT__
  115.         , XDR_DUMMY=32767
  116. #endif
  117. };
  118.  
  119. /*
  120.  * This is the number of bytes per unit of external data.
  121.  */
  122. #define BYTES_PER_XDR_UNIT      (4)
  123. #define RNDUP(x)  ((((x) + BYTES_PER_XDR_UNIT - 1) / BYTES_PER_XDR_UNIT) \
  124.                     * BYTES_PER_XDR_UNIT)
  125.  
  126. /*
  127.  * A xdrproc_t exists for each data type which is to be encoded or decoded.
  128.  *
  129.  * The second argument to the xdrproc_t is a pointer to an opaque pointer.
  130.  * The opaque pointer generally points to a structure of the data type
  131.  * to be decoded.  If this pointer is 0, then the type routines should
  132.  * allocate dynamic storage of the appropriate size and return it.
  133.  * bool_t       (*xdrproc_t)(XDR *, caddr_t *);
  134.  */
  135.  
  136. /*
  137.  * The XDR handle.
  138.  * Contains operation which is being applied to the stream,
  139.  * an operations vector for the paticular implementation (e.g. see xdr_mem.c),
  140.  * and two private fields for the use of the particular impelementation.
  141.  */
  142. typedef _Packed struct _XDR {
  143.         enum xdr_op     x_op;           /* operation; fast additional param */
  144.         struct xdr_ops {
  145.                 bool_t  (* _Seg16 _Far16 _Cdecl x_getlong)(_Packed struct _XDR * _Seg16,void * _Seg16); /* get a long from underlying stream */
  146.                 bool_t  (* _Seg16 _Far16 _Cdecl x_putlong)(_Packed struct _XDR * _Seg16,void * _Seg16); /* put a long to " */
  147.                 bool_t  (* _Seg16 _Far16 _Cdecl x_getbytes)(_Packed struct _XDR * _Seg16,void * _Seg16,short);/* get some bytes from " */
  148.                 bool_t  (* _Seg16 _Far16 _Cdecl x_putbytes)(_Packed struct _XDR * _Seg16,void * _Seg16,short);/* put some bytes to " */
  149.                 u_int   (* _Seg16 _Far16 _Cdecl x_getpostn)(_Packed struct _XDR * _Seg16);/* returns bytes off from beginning */
  150.                 bool_t  (* _Seg16 _Far16 _Cdecl x_setpostn)(_Packed struct _XDR * _Seg16,unsigned short);/* lets you reposition the stream */
  151.                 long * _Seg16 (* _Seg16 _Far16 _Cdecl x_inline)(_Packed struct _XDR * _Seg16,short);  /* buf quick ptr to buffered data */
  152.                 void    (* _Seg16 _Far16 _Cdecl x_destroy)(_Packed struct _XDR * _Seg16,short); /* free privates of this xdr_stream */
  153.         } * _Seg16 x_ops;
  154.         char * _Seg16   x_public;       /* users' data */
  155.         char * _Seg16   x_private;      /* pointer to private data */
  156.         char * _Seg16   x_base;         /* private used for position info */
  157.         short           x_handy;        /* extra private word */
  158. } XDR;
  159.  
  160. #ifdef __32BIT__
  161. #pragma checkout(suspend)
  162. #endif
  163. typedef bool_t (* _Seg16 _Far16 _Cdecl xdrproc_t)();
  164. #ifdef __32BIT__
  165. #pragma checkout(resume)
  166. #endif
  167. /*
  168.  * Operations defined on a XDR handle
  169.  *
  170.  * XDR          *xdrs;
  171.  * long         *longp;
  172.  * caddr_t       addr;
  173.  * u_int         len;
  174.  * u_int         pos;
  175.  */
  176. #define XDR_GETLONG(xdrs, longp)                        \
  177.         (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
  178. #define xdr_getlong(xdrs, longp)                        \
  179.         (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
  180.  
  181. #define XDR_PUTLONG(xdrs, longp)                        \
  182.         (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
  183. #define xdr_putlong(xdrs, longp)                        \
  184.         (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
  185.  
  186. #define XDR_GETBYTES(xdrs, addr, len)                   \
  187.         (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
  188. #define xdr_getbytes(xdrs, addr, len)                   \
  189.         (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
  190.  
  191. #define XDR_PUTBYTES(xdrs, addr, len)                   \
  192.         (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
  193. #define xdr_putbytes(xdrs, addr, len)                   \
  194.         (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
  195.  
  196. #define XDR_GETPOS(xdrs)                                \
  197.         (*(xdrs)->x_ops->x_getpostn)(xdrs)
  198. #define xdr_getpos(xdrs)                                \
  199.         (*(xdrs)->x_ops->x_getpostn)(xdrs)
  200.  
  201. #define XDR_SETPOS(xdrs, pos)                           \
  202.         (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
  203. #define xdr_setpos(xdrs, pos)                           \
  204.         (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
  205.  
  206. #define XDR_INLINE(xdrs, len)                           \
  207.         (*(xdrs)->x_ops->x_inline)(xdrs, len)
  208. #define xdr_inline(xdrs, len)                           \
  209.         (*(xdrs)->x_ops->x_inline)(xdrs, len)
  210.  
  211. #define XDR_DESTROY(xdrs)                               \
  212.         if ((xdrs)->x_ops->x_destroy)                   \
  213.                 (*(xdrs)->x_ops->x_destroy)(xdrs)
  214. #define xdr_destroy(xdrs)                               \
  215.         if ((xdrs)->x_ops->x_destroy)                   \
  216.                 (*(xdrs)->x_ops->x_destroy)(xdrs)
  217.  
  218. /*
  219.  * Support struct for discriminated unions.
  220.  * You create an array of xdrdiscrim structures, terminated with
  221.  * a entry with a null procedure pointer.  The xdr_union routine gets
  222.  * the discriminant value and then searches the array of structures
  223.  * for a matching value.  If a match is found the associated xdr routine
  224.  * is called to handle that part of the union.  If there is
  225.  * no match, then a default routine may be called.
  226.  * If there is no match and no default routine it is an error.
  227.  */
  228. #define NULL_xdrproc_t ((xdrproc_t)0)
  229. _Packed struct xdr_discrim {
  230.         short   value;
  231.         xdrproc_t proc;
  232. };
  233.  
  234. /*
  235.  * In-line routines for fast encode/decode of primitve data types.
  236.  * Caveat emptor: these use single memory cycles to get the
  237.  * data from the underlying buffer, and will fail to operate
  238.  * properly if the data is not aligned.  The standard way to use these
  239.  * is to say:
  240.  *      if ((buf = XDR_INLINE(xdrs, count)) == NULL)
  241.  *              return (FALSE);
  242.  *      <<< macro calls >>>
  243.  * where ``count'' is the number of bytes of data occupied
  244.  * by the primitive data types.
  245.  *
  246.  * N.B. and frozen for all time: each data type here uses 4 bytes
  247.  * of external representation.
  248.  */
  249. #define IXDR_GET_LONG(buf)              ((long)ntohl((u_long)*(buf)++))
  250. #define IXDR_PUT_LONG(buf, v)           (*(buf)++ = (long)htonl((u_long)v))
  251.  
  252. #define IXDR_GET_BOOL(buf)              ((bool_t)IXDR_GET_LONG(buf))
  253. #define IXDR_GET_ENUM(buf, t)           ((t)IXDR_GET_LONG(buf))
  254. #define IXDR_GET_U_LONG(buf)            ((u_long)IXDR_GET_LONG(buf))
  255. #define IXDR_GET_SHORT(buf)             ((short)IXDR_GET_LONG(buf))
  256. #define IXDR_GET_U_SHORT(buf)           ((u_short)IXDR_GET_LONG(buf))
  257.  
  258. #define IXDR_PUT_BOOL(buf, v)           IXDR_PUT_LONG((buf), ((long)(v)))
  259. #define IXDR_PUT_ENUM(buf, v)           IXDR_PUT_LONG((buf), ((long)(v)))
  260. #define IXDR_PUT_U_LONG(buf, v)         IXDR_PUT_LONG((buf), ((long)(v)))
  261. #define IXDR_PUT_SHORT(buf, v)          IXDR_PUT_LONG((buf), ((long)(v)))
  262. #define IXDR_PUT_U_SHORT(buf, v)        IXDR_PUT_LONG((buf), ((long)(v)))
  263.  
  264. /*
  265.  * These are the "generic" xdr routines.
  266.  */
  267. #if 0
  268. extern bool_t   xdr_void();
  269. extern bool_t   xdr_int();
  270. extern bool_t   xdr_u_int();
  271. extern bool_t   xdr_long();
  272. extern bool_t   xdr_u_long();
  273. extern bool_t   xdr_short();
  274. extern bool_t   xdr_u_short();
  275. extern bool_t   xdr_bool();
  276. extern bool_t   xdr_enum();
  277. extern bool_t   xdr_array();
  278. extern bool_t   xdr_bytes();
  279. extern bool_t   xdr_opaque();
  280. extern bool_t   xdr_string();
  281. extern bool_t   xdr_union();
  282. extern bool_t   xdr_char();
  283. extern bool_t   xdr_u_char();
  284. extern bool_t   xdr_vector();
  285. extern bool_t   xdr_float();
  286. extern bool_t   xdr_double();
  287. extern bool_t   xdr_reference();
  288. extern bool_t   xdr_pointer();
  289. extern bool_t   xdr_wrapstring();
  290. #endif
  291.  
  292. /*
  293.  * Common opaque bytes objects used by many rpc protocols;
  294.  * declared here due to commonality.
  295.  */
  296. #define MAX_NETOBJ_SZ 1024
  297. _Packed struct netobj {
  298.         u_short n_len;
  299.         char    * _Seg16 n_bytes;
  300. };
  301. typedef _Packed struct netobj netobj;
  302.  
  303. /*
  304.  * These are the public routines for the various implementations of
  305.  * xdr streams.
  306.  */
  307. #ifdef __32BIT__
  308. #pragma linkage(xdr_accepted_reply,far16 cdecl)
  309. #pragma linkage(xdr_array,far16 cdecl)
  310. #pragma linkage(xdr_bool,far16 cdecl)
  311. #pragma linkage(xdr_bytes,far16 cdecl)
  312. #pragma linkage(xdr_callhdr,far16 cdecl)
  313. #pragma linkage(xdr_callmsg,far16 cdecl)
  314. #pragma linkage(xdr_char,far16 cdecl)
  315. #pragma linkage(xdr_deskey,far16 cdecl)
  316. #pragma linkage(xdr_double,far16 cdecl)
  317. #pragma linkage(xdr_enum,far16 cdecl)
  318. #pragma linkage(xdr_float,far16 cdecl)
  319. #pragma linkage(xdr_free,far16 cdecl)
  320. #pragma linkage(xdr_int,far16 cdecl)
  321. #pragma linkage(xdr_long,far16 cdecl)
  322. #pragma linkage(xdr_netobj,far16 cdecl)
  323. #pragma linkage(xdr_opaque,far16 cdecl)
  324. #pragma linkage(xdr_opaque_auth,far16 cdecl)
  325. #pragma linkage(xdr_pointer,far16 cdecl)
  326. #pragma linkage(xdr_reference,far16 cdecl)
  327. #pragma linkage(xdr_rejected_reply,far16 cdecl)
  328. #pragma linkage(xdr_replymsg,far16 cdecl)
  329. #pragma linkage(xdr_short,far16 cdecl)
  330. #pragma linkage(xdr_string,far16 cdecl)
  331. #pragma linkage(xdr_u_char,far16 cdecl)
  332. #pragma linkage(xdr_u_int,far16 cdecl)
  333. #pragma linkage(xdr_u_long,far16 cdecl)
  334. #pragma linkage(xdr_u_short,far16 cdecl)
  335. #pragma linkage(xdr_union,far16 cdecl)
  336. #pragma linkage(xdr_vector,far16 cdecl)
  337. #pragma linkage(xdr_void,far16 cdecl)
  338. #pragma linkage(xdr_wrapstring,far16 cdecl)
  339. #pragma linkage(xdrmem_create,far16 cdecl)
  340. #pragma linkage(xdrrec_create,far16 cdecl)
  341. #pragma linkage(xdrrec_endofrecord,far16 cdecl)
  342. #pragma linkage(xdrrec_eof,far16 cdecl)
  343. #pragma linkage(xdrrec_skiprecord,far16 cdecl)
  344. #pragma linkage(xdrstdio_create,far16 cdecl)
  345. #endif
  346. bool_t   xdr_accepted_reply(XDR * , void * );
  347. bool_t   xdr_array(XDR * , char *  * , u_short * , u_short, u_short, xdrproc_t);
  348. bool_t   xdr_bool(XDR * , short * );
  349. bool_t   xdr_bytes(XDR * , char * *, u_short * , u_long);
  350. bool_t   xdr_callhdr( XDR * , void * );
  351. bool_t   xdr_callmsg(XDR * , void * );
  352. bool_t   xdr_char( XDR * , char * );
  353. bool_t   xdr_deskey(XDR * , void * );
  354. bool_t   xdr_double(XDR * , double * );
  355. bool_t   xdr_enum(XDR * ,void * );
  356. bool_t   xdr_float(  XDR * , float * );
  357. bool_t   xdr_int( XDR * , short * );
  358. bool_t   xdr_long(XDR * , long * );
  359. bool_t   xdr_netobj( XDR * , _Packed struct netobj * );
  360. bool_t   xdr_opaque(XDR * , void * , u_long);
  361. bool_t   xdr_opaque_auth(XDR * , void * );
  362. bool_t   xdr_pointer(XDR * , char * * , u_short, xdrproc_t);
  363. bool_t   xdr_reference(XDR * , void *  * , u_short, xdrproc_t);
  364. bool_t   xdr_rejected_reply(XDR * , void * );
  365. bool_t   xdr_replymsg(XDR * , void * );
  366. bool_t   xdr_short(XDR * , short * );
  367. bool_t   xdr_string(XDR * ,char * * , u_long);
  368. bool_t   xdr_u_char( XDR * , u_char * );
  369. bool_t   xdr_u_int( XDR * , u_short * );
  370. bool_t   xdr_u_long(XDR * ,u_long * );
  371. bool_t   xdr_u_short(XDR * , u_short * );
  372. bool_t   xdr_union(XDR * , enum_t * , char * , _Packed struct xdr_discrim * , xdrproc_t);
  373. bool_t   xdr_vector(XDR * , char * , u_short, u_short, xdrproc_t);
  374. bool_t   xdr_void(void);
  375. bool_t   xdr_wrapstring( XDR * , char * * );
  376. bool_t   xdrrec_endofrecord( XDR * , bool_t);
  377. bool_t   xdrrec_eof( XDR * );
  378. bool_t   xdrrec_skiprecord( XDR * );
  379. void     xdrmem_create(XDR *,void *,u_short,enum xdr_op);          /* XDR using memory buffers */
  380. void     xdrstdio_create(XDR *,void *,enum xdr_op);        /* XDR using stdio library */
  381. void   xdr_free( xdrproc_t , void * );
  382. void   xdrrec_create(XDR * , u_short,u_short, char * , short (*  )(void *,short,short), short (*  )(void *,void *,short));
  383. #ifdef __32BIT__
  384. #pragma checkout(suspend)
  385. short _Far16 _Cdecl registerrpc(unsigned long, unsigned long, unsigned long,
  386.   void * _Seg16 (* _Seg16 _Far16 _Cdecl myproc)(),
  387.   xdrproc_t,
  388.   xdrproc_t);
  389. #pragma checkout(resume)
  390. #else
  391. short _Far16 _Cdecl registerrpc();
  392. #endif
  393. #endif /* RPC_XDR_H */
  394.